Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix kubectl completion zsh to use any command name rather than hardcoded kubectl #106969

Merged
merged 2 commits into from
Jan 5, 2022
Merged

Fix kubectl completion zsh to use any command name rather than hardcoded kubectl #106969

merged 2 commits into from
Jan 5, 2022

Conversation

paulbarfuss
Copy link
Contributor

What type of PR is this?

/kind bug
/kind regression

What this PR does / why we need it:

Improves code by replacing a hardcoded value kubectl with an existing function to generate the name *cobra.Command.Name()

This helps anyone downstream that wraps this with another command to continue to use $command completion zsh with alternate tooling.

Which issue(s) this PR fixes:

Fixes #106968

Special notes for your reviewer:

Please let me know if you need any additional info from me. Thanks!

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/bug Categorizes issue or PR as related to a bug. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. kind/regression Categorizes issue or PR as related to a regression from a prior release. labels Dec 10, 2021
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Dec 10, 2021 •
edited

CLA Signed

The committers are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Dec 10, 2021
@k8s-ci-robot
Copy link
Contributor

@paulbarfuss: This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot
Copy link
Contributor

Welcome @paulbarfuss!

It looks like this is your first PR to kubernetes/kubernetes 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kubernetes has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @paulbarfuss. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Dec 10, 2021
@k8s-ci-robot k8s-ci-robot added area/kubectl sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Dec 10, 2021
@paulbarfuss
Copy link
Contributor Author

/check-cla

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Dec 10, 2021
@KnVerey
Copy link
Contributor

KnVerey commented Dec 23, 2021

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 23, 2021
@KnVerey
Copy link
Contributor

KnVerey commented Dec 23, 2021

/test pull-kubernetes-node-e2e-containerd

@KnVerey
Copy link
Contributor

KnVerey commented Dec 23, 2021

Seems like we already use command.Name() for the program name elsewhere in the completion code. 👍

/lgtm
/test pull-kubernetes-integration
/assign @soltysh

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 23, 2021
SataQiu
SataQiu reviewed Jan 2, 2022
View reviewed changes
Copy link
Member

@SataQiu SataQiu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

This was referenced Jan 3, 2022
Closed
Closed
marckhouzam
marckhouzam approved these changes Jan 3, 2022
View reviewed changes
Copy link
Member

@marckhouzam marckhouzam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm the one that mistakenly hard-coded kubectl in the zshHeader string. I wasn't aware that other tools wrapped this functionality.

The proposed change looks good to me.

@KnVerey
Copy link
Contributor

KnVerey commented Jan 5, 2022

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: KnVerey, marckhouzam, paulbarfuss

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 5, 2022
@k8s-ci-robot k8s-ci-robot merged commit 8abf7dc into kubernetes:master Jan 5, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.24 milestone Jan 5, 2022
@paulbarfuss paulbarfuss deleted the fix-kubectl-completion-zsh branch January 5, 2022 22:01
@soltysh soltysh mentioned this pull request Apr 1, 2022
Merged
@soltysh
Copy link
Contributor

soltysh commented Apr 1, 2022

/release-note-edit Fix kubectl completion zsh to use any command name rather than hardcoded kubectl

k8s-ci-robot added a commit that referenced this pull request Apr 28, 2022
@k8s-ci-robot
Merge pull request #109235 from soltysh/automated-cherry-pick-of-#106…
cb81d24 
…969-upstream-release-1.23

Automated cherry pick of #106969: kubectl: fix hard-coded value in zsh completion
@liggitt liggitt removed the kind/regression Categorizes issue or PR as related to a regression from a prior release. label Sep 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SataQiu SataQiu SataQiu left review comments

@marckhouzam marckhouzam marckhouzam approved these changes

@KnVerey KnVerey Awaiting requested review from KnVerey

@soltysh soltysh Awaiting requested review from soltysh

Assignees

@soltysh soltysh

@KnVerey KnVerey

@SataQiu SataQiu

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/kubectl cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. sig/cli Categorizes an issue or PR as relevant to SIG CLI. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
v1.24
Development

Successfully merging this pull request may close these issues.

kubectl completion zsh is generating hardcoded values which break downstream kubectl wrappers
7 participants
@paulbarfuss @k8s-ci-robot @KnVerey @soltysh @marckhouzam @SataQiu @liggitt